List all Locations

Authorizations

Authorization

string

header

required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

integer<int32>

required

The id of the referenced Warehouse.

Query Parameters

fields

enum<string>[]

Specify additional fields of the Location object to be included in the response.

Available options:

basic,

all,

label,

priority,

qty_on_hand,

qty_putaway,

qty_unreserved,

qty_reserved,

qty_locked,

is_temp,

is_pickable,

is_type_auto,

created_at,

updated_at,

last_cyclecount_at,

lot,

product,

rack,

location_type

fields:lot

enum<string>[]

Specify additional fields of the Lot object to be included in the response.

Available options:

basic,

all,

id,

lot_number,

origination_date,

expiration_date,

is_expired,

is_active,

lot_number_input,

expiration_input,

sort_value,

days_until_expiration,

sort_direction,

group_value,

created_at,

updated_at,

created_by,

lot_type,

product

fields:lot.lot_type

enum<string>[]

Specify additional fields of the LotType object (via Lot) to be included in the response. See the selecting fields page for more information. Specify additional fields of the LotType object to be included in the response.

Available options:

basic,

all,

allow_mixing_locations,

allow_mixing_fulfillment,

lot_number_example,

lot_number_replacement,

expiration_date_pattern,

expiration_date_delta,

created_at,

updated_at

fields:lot.product

enum<string>[]

Specify additional fields of the Product object (via Lot) to be included in the response. See the selecting fields page for more information. Specify additional fields of the Product or Packaging* object to be included in the response.

Available options:

basic,

all,

created_at,

updated_at,

container_options,

supplies_options,

data_collection_options,

instruction_options,

infill_options,

vendor_sku,

external_id,

barcodes,

goods_type,

is_available,

is_visible,

weight,

dimensions,

volume,

inventory,

export,

regulated_goods,

packaging,

custom_fields

fields:product

enum<string>[]

Specify additional fields of the Product or Packaging* object to be included in the response.

Available options:

basic,

all,

created_at,

updated_at,

container_options,

supplies_options,

data_collection_options,

instruction_options,

infill_options,

vendor_sku,

external_id,

barcodes,

goods_type,

is_available,

is_visible,

weight,

dimensions,

volume,

inventory,

export,

regulated_goods,

packaging,

custom_fields

fields:product.merchant

enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

Available options:

basic,

all,

code,

name,

status,

created_at,

updated_at,

brands,

default_brand

fields:rack

enum<string>[]

Specify additional fields of the Rack object to be included in the response.

Available options:

all,

id,

name,

location_pattern,

picking_order,

warehouse

fields:rack.warehouse

enum<string>[]

Specify additional fields of the Warehouse object (via Rack) to be included in the response. See the selecting fields page for more information. Specify additional fields of the Warehouse object to be included in the response.

Available options:

all

fields:location_type

enum<string>[]

Specify additional fields of the LocationType object to be included in the response.

Available options:

basic,

all,

name,

is_pickable,

created_at,

updated_at

filter

string[]

Using the filtering syntax, you may filter the results using the following fields:

id
label
created_at
updated_at
qty_putaway
qty_unreserved
qty_reserved

sort

string

The default sort order is descending by primary key (sort=-id). The following fields are available for sorting:

id
label

count

integer

If specified as 1, the meta.count property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the next property of the response. See paging parameters for more information.

Required range: 0 <= x <= 1

cursor_end

integer

A cursor for use in pagination which defines the last id of the next page of results, non-inclusive. See paging parameters for more information on paging.

cursor_start

integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

limit

integer

default:100

A limit on the number of objects to be returned.

Required range: 1 <= x <= 1000

Example:

100

Response

A dictionary with a collection property that contains a list of up to limit Location objects matching the query.

collection

Location · object[]

A list of Location objects.

Show child attributes

collection.type

enum<string>

This is a read-only property that describes the type of object in the response body.

Available options:

Location

collection.id

integer

The internal id property used as a path parameter in a resource lookup.

Example:

42

collection.label

string | null

The human-readable name of a location and also the value encoded in location's barcode label. This value must be unique within each warehouse.

Example:

"A4-55-C3"

collection.priority

integer

The inventory reservation order relative to other locations containing the same product.

Example:

10

collection.qty_putaway

number<double> | null

The quantity of a product associated with a Delivery that have not yet been committed to the inventory.

Example:

10

collection.qty_unreserved

number<double> | null

The quantity of a product not yet assigned to a specific Shipment. This does not imply that the inventory is Available.

Example:

20

collection.qty_reserved

number<double> | null

The quantity assigned to a Shipment or Work Order and ready to be picked.

Example:

4

collection.qty_on_hand

number<double> | null

The "On Hand" amount is the same as Put-Away + Unreserved + Reserved quantities.

Example:

34

collection.qty_locked

number<double> | null

The quantity that is reserved to a Shipment or Work Order as chosen specifically by a user and therefore should not be re-reserved to a new location on the fly in the event that an adjustment needs to re-optimize pick locations. This amount is already included in qty_reserved so is not added again to qty_on_hand.
Optional Field

Example:

4

collection.is_temp

boolean | null

Temporary locations are used to track inventory that is being relocated and cannot be created or modified.
Optional Field

Example:

false

collection.is_pickable

boolean | null

Whether or not the location is considered to be easy to pick from for the purpose of generating pickable batches.
Optional Field

Example:

true

collection.is_type_auto

boolean | null

If Location Type is "Automatic" then it will cause the type to be maintained automatically according to the Auto-Assign Patterns of the location types.
Optional Field

Example:

true

collection.created_at

string<datetime> | null

The date and time when the object was created.
Optional Field

Example:

"2021-11-17T14:32:44Z"

collection.updated_at

string<datetime>

The date and time when the object was last updated.
Optional Field

Example:

"2021-11-17T14:32:44Z"

collection.last_cyclecount_at

string<datetime> | null

The date and time when last cycle count was performed.
Optional Field

Example:

"2021-11-17T14:32:44Z"

collection.lot

LotRef · object

A reference to the Lot object assigned to this location.

Show child attributes

collection.lot.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Lot

collection.lot.id

integer

required

The internal id property used as a path parameter in a resource lookup.

Example:

54

collection.product

StockableProductRef · object

A reference to the stockable product assigned to this location.

Show child attributes

collection.product.type

enum<string>

required

This is a read-only property that describes the type of object in the response body.

Available options:

Product,

PackagingContainer,

PackagingInfill,

PackagingSupplies

collection.product.id

integer<int32>

required

The internal, read-only, id property used as a path parameter in a resource lookup.

collection.rack

RackRef · object

A reference to the Rack to which this location is assigned. This may be managed automatically or assigned manually.

Show child attributes

collection.rack.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Rack

collection.rack.id

integer

required

The internal id property used as a path parameter in a resource lookup.

collection.location_type

LocationTypeRef · object

A reference to the LocationType object assigned to this location. This may be managed automatically or assigned manually.

Show child attributes

collection.location_type.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

LocationType

collection.location_type.id

integer

required

The internal id property used as a path parameter in a resource lookup.

Example:

54

included

object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.

Show child attributes

included.LocationType

LocationType · object[]

Show child attributes

included.LocationType.type

enum<string>

This is a read-only property that describes the type of object in the response body.

Available options:

LocationType

included.LocationType.id

integer

The internal id property used as a path parameter in a resource lookup.

Example:

54

included.LocationType.name

string

The descriptive name of the location type.

Example:

"Pickable Pallets"

included.LocationType.is_pickable

boolean

default:false

Whether or not the location is considered to be easy to pick from for the purpose of generating pickable batches.

included.Lot

(Lot · object | null)[]

The Lot records the time some inventory was originated (first received or otherwise created) and optionally a lot number and expiration date and may affect the order in which inventory is "burned" depending on the LotType.

Show child attributes

included.Lot.type

enum<string>

This is a read-only property that describes the type of object in the response body.

Available options:

Lot

included.Lot.id

integer

The internal id property used as a path parameter in a resource lookup.

Example:

54

included.LotType

LotType · object[]

Show child attributes

included.LotType.type

enum<string>

This is a read-only property that describes the type of object in the response body.

Available options:

LotType

included.LotType.id

integer<int64>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.LotType.name

string

Any string which uniquely identifies a LotType.

Required string length: 1 - 255

Example:

"MixFulfillment-Extract-Choose-FEFO"

included.LotType.allow_mixing_locations

boolean

This flag must be true for mixing with other Lots/Expirations in the same location..

Example:

true

included.LotType.allow_mixing_fulfillment

boolean

This flag must be true for mixing with other Lots/Expirations when fulfilling an order..

Example:

true

included.LotType.lot_number_input

enum<string>

The input method used when processing a lot number..

Available options:

none,

choose_date,

extract_date,

text

Example:

"text"

included.LotType.lot_number_example

string

Enter a typical example of a lot number which can be used to validate the Lot Number Pattern. It will also be displayed as an example when users are prompted for input.

Example:

"AB190405G"

included.LotType.lot_number_pattern

string

Enter a RegEx for capturing the Lot Number Input. Regex must contain one or more capturing group.

Example:

"^([A-Z]{2}-[0-9]+)$"

included.LotType.lot_number_replacement

string

Enter a RegEx to either save the Lot Number Input as is or transform the entry into something more readable. Must contain one or more non-empty capturing group from the Lot Number Pattern.

Example:

"$2$1"

included.LotType.expiration_date

enum<string>

The input method used when processing the expiration date.

Available options:

none,

choose_date,

extract_date,

lot_number_date

Example:

"lot_number_date"

included.LotType.burn_order

enum<string>

Specifies what stock should be used first when fulfilling orders.

Available options:

none,

fifo,

lifo,

fefo,

lefo,

fifo_lot_number,

lifo_lot_number

Example:

"fefo"

included.LotType.created_at

string<date-time>

The date and time the object was created in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:32:28Z"

included.LotType.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:39:43Z"

included.Merchant

Merchant · object[]

Show child attributes

included.Merchant.type

enum<string>

Available options:

Merchant

included.Merchant.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Merchant.code

string

Merchant code may only contain letters (a-z), numbers (0-9) or underscore(_), the first character must be a letter.

Required string length: 1 - 32

Example:

"acme_inc"

included.Merchant.name

string

Any string which uniquely identifies a Merchant.

Required string length: 1 - 64

Example:

"ACME Inc."

included.Merchant.status

enum<string> | null

default:active

Lifecycle status of the Merchant:

active: Merchant is operational and available for use
suspended: Temporarily on hold, can be easily reactivated
inactive: Long-term offline status, reactivation is possible but may require additional steps
archived: Soft delete status, manual recovery required

Available options:

active,

inactive,

suspended,

archived

Example:

"active"

included.Merchant.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.Merchant.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:39:43Z"

included.Merchant.brands

BrandRef · object[]

A merchant must have one or more brands which may share the same pool of inventory. Brands can be used for customizing presentation and behaviors and often correspond to distinct lines of business or market presences.
Optional Field

Show child attributes

included.Merchant.brands.type

enum<string>

required

Available options:

Brand

included.Merchant.brands.id

integer<int32>

required

The numeric id of a particular resource being updated.

Example:

4

included.Merchant.default_brand

BrandRef · object

This is the primary brand used when defining only the merchant for operations such as creating a new product.
Optional Field

Show child attributes

included.Merchant.default_brand.type

enum<string>

required

Available options:

Brand

included.Merchant.default_brand.id

integer<int32>

required

The numeric id of a particular resource being updated.

Example:

4

included.PackagingContainer

PackagingContainer · object[]

Show child attributes

included.PackagingContainer.type

enum<string>

This property describes the type of object in the response body.

Available options:

PackagingContainer

included.PackagingContainer.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.PackagingContainer.container_options

object

Show child attributes

included.PackagingContainer.container_options.barcodes

A comma separated list of unique packaging feature barcodes.
Optional Field

Example:

"956623520-4"

included.PackagingContainer.container_options.weight

Weight · object

The weight of the container when packed with the shipment items.

Show child attributes

included.PackagingContainer.container_options.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingContainer.container_options.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingContainer.container_options.dimensions

Dimensions · object

The dimensions of the container in imperial or metric units.

Show child attributes

included.PackagingContainer.container_options.dimensions.length

number<float>

This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places.

Example:

8

included.PackagingContainer.container_options.dimensions.width

number<float>

This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

6

included.PackagingContainer.container_options.dimensions.height

number<float>

This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

4

included.PackagingContainer.container_options.dimensions.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

included.PackagingContainer.container_options.volume

Volume · object

The total volume of the container in imperial or metric units.

Show child attributes

included.PackagingContainer.container_options.volume.value

number<float>

This value describes the cubic size of the subject as a floating-point number up to 4 decimal places.

Example:

300

included.PackagingContainer.container_options.volume.unit

enum<string>

The imperical or metric unit of measurement as a cubic value.

Available options:

in^3,

mm^3,

cm^3,

m^3

included.PackagingContainer.container_options.manage_stock

enum<boolean>

This flag indicates whether or not to adjust the inventory quantity of the packaging feature with each use. If true then the inventory levels will decrease with each use. If no then the inventory will not adjust with each use.

Available options:

true,

false

included.PackagingContainer.container_options.associated_products

ProductRef · object[]

A list of products with this packaging feature selected in its "Other Special Features" option in the product's "Packaging" tab.

Show child attributes

included.PackagingContainer.container_options.associated_products.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.PackagingContainer.container_options.associated_products.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.PackagingContainer.container_options.allow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will only be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingContainer.container_options.allow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingContainer.container_options.allow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingContainer.container_options.disallow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will not be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingContainer.container_options.disallow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingContainer.container_options.disallow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingContainer.container_options.billing_amount

Monetary · object

The amount that will be billable for consumption of one unit of this packaging feature.
Optional Field

Show child attributes

included.PackagingContainer.container_options.billing_amount.amount

number<float>

This is the monetary value..

Example:

99

included.PackagingContainer.container_options.billing_amount.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.PackagingContainer.container_options.allow_for_warehouses

(WarehouseRef · object | null)[]

If specified, this packaging feature will only be applicable to the selected warehouses.

A reference to a Warehouse by id.

Show child attributes

included.PackagingContainer.container_options.allow_for_warehouses.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Warehouse

included.PackagingContainer.container_options.allow_for_warehouses.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

included.PackagingContainer.container_options.allow_for_shipping_methods

string[]

If specified, this packaging feature will only be applicable to the selected carriers/shipping methods.

included.PackagingContainer.container_options.satisfies_overbox

enum<boolean>

Will be a valid container for products which have Requires Overbox: Yes.

Available options:

true,

false

included.PackagingContainer.container_options.use_for_bin_packing

enum<string>

Containers with "Use for Bin Packing: No" will not be used by packing solution providers.

Available options:

yes,

no,

fallback

included.PackagingContainer.container_options.weight_capacity

Weight · object

Maximum allowed weight of the container, including tare weight. Optional Field

Show child attributes

included.PackagingContainer.container_options.weight_capacity.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingContainer.container_options.weight_capacity.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingContainer.container_options.container_style

enum<string>

Specify the container type. Currently, only "Rigid Box" is supported.

Available options:

rigid_box

included.PackagingContainer.container_options.packaging_handling_surcharge

enum<boolean>

The Packaging Surcharge is applicable for this packaging feature (e.g. cylindrical, non-fiberboard material, protrusions, non-conveyable, etc.)

Available options:

true,

false

included.PackagingContainer.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.PackagingContainer.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.PackagingContainer.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.PackagingContainer.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.PackagingContainer.merchant.type

enum<string>

required

Available options:

Merchant

included.PackagingContainer.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingContainer.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.PackagingContainer.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.PackagingDataCollection

PackagingDataCollection · object[]

Show child attributes

included.PackagingDataCollection.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.PackagingDataCollection.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.PackagingDataCollection.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.PackagingDataCollection.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.PackagingDataCollection.merchant.type

enum<string>

required

Available options:

Merchant

included.PackagingDataCollection.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingDataCollection.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.PackagingDataCollection.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.PackagingDataCollection.type

enum<string>

This property describes the type of object in the response body.

Available options:

PackagingDataCollection

included.PackagingDataCollection.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.PackagingDataCollection.data_collection_options

object

Show child attributes

included.PackagingDataCollection.data_collection_options.associated_products

ProductRef · object[]

A list of products with this packaging feature selected in its "Other Special Features" option in the product's "Packaging" tab.

Show child attributes

included.PackagingDataCollection.data_collection_options.associated_products.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.PackagingDataCollection.data_collection_options.associated_products.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.PackagingDataCollection.data_collection_options.allow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will only be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingDataCollection.data_collection_options.allow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingDataCollection.data_collection_options.allow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingDataCollection.data_collection_options.disallow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will not be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingDataCollection.data_collection_options.disallow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingDataCollection.data_collection_options.disallow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingDataCollection.data_collection_options.billing_amount

Monetary · object

The amount that will be billable for consumption of one unit of this packaging feature.
Optional Field

Show child attributes

included.PackagingDataCollection.data_collection_options.billing_amount.amount

number<float>

This is the monetary value..

Example:

99

included.PackagingDataCollection.data_collection_options.billing_amount.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.PackagingDataCollection.data_collection_options.allow_for_shipping_methods

string[]

If specified, this packaging feature will only be applicable to the selected carriers/shipping methods.

included.PackagingDataCollection.data_collection_options.apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments containing an item with this Goods Type. \

NORMAL Not Regulated
ORM_D ORM-D Optional Field

Available options:

any,

NORMAL,

ORM_D

included.PackagingDataCollection.data_collection_options.never_apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments which do not contain an item with this Goods Type. \

NORMAL Not Regulated
LIMITED_QUANTITIES_COMMODITIES Limited Quantities: Consumer Commodity
HAZMAT Regulated Optional Field

Available options:

NORMAL,

LIMITED_QUANTITIES_COMMODITIES,

HAZMAT

included.PackagingDataCollection.data_collection_options.apply_only_above_weight

Weight · object

If specified, this packaging product is not a requirement for packages under the given weight when "Always/Never Apply to Goods Type" is specified. Optional Field

Show child attributes

included.PackagingDataCollection.data_collection_options.apply_only_above_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingDataCollection.data_collection_options.apply_only_above_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingDataCollection.data_collection_options.one_per

enum<string>

The expected number of scans per shipment. The product "Unit Quantity" is used as a multiplier for "One Scan Per: Each".

Available options:

order,

package,

item,

each

included.PackagingDataCollection.data_collection_options.require_scan_timing

enum<string>

Choose how the scan timer should begin recording time data on this product or packaging feature.

Available options:

after_product_scan|on_full,

on_start

included.PackagingDataCollection.data_collection_options.disable_confirm_button

enum<boolean>

If "No", the user will be able to tap "Confirm" rather than scanning a barcode.

Available options:

true,

false

included.PackagingDataCollection.data_collection_options.require_packaging_type

enum<string>

If specified, this packaging feature will only be applicable when the container meets the chosen criteria based on the container's "Satisfies Overbox" attribute when "Always/Never Apply to Goods Type" is specified.

Available options:

overbox,

non_overbox

included.PackagingDataCollection.data_collection_options.apply_unless_container_meets_hazmat

enum<boolean>

If "Yes", this packaging product will be applicable unless a package contains a DG item with "Container Meets Hazmat Specs: Yes" when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingDataCollection.data_collection_options.apply_to_multi_sku_package

enum<boolean>

If "Yes", this packaging product will only be applied to packages containing more than one SKU when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingDataCollection.data_collection_options.collect_data_pattern

string

Specify a Javascript-compatible regular expression which describes the format of the data to be collected. Examples: ".+" for anything, or "^[0-9]{15}$" for a 15-digit number. See http://regexpal.com/

included.PackagingDataCollection.data_collection_options.apply_to_region

string

Unless specified, this packaging feature will apply to all regions when "Always/Never Apply to Goods Type" is specified.

included.PackagingDataCollection.data_collection_options.is_collected_data_unique

enum<boolean>

Prevent the same data collection value from being collected more than once on the same shipment.

Available options:

true,

false

included.PackagingInfill

PackagingInfill · object[]

Show child attributes

included.PackagingInfill.type

enum<string>

This property describes the type of object in the response body.

Available options:

PackagingInfill

included.PackagingInfill.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.PackagingInfill.infill_options

object

Show child attributes

included.PackagingInfill.infill_options.barcodes

A comma separated list of unique packaging feature barcodes.
Optional Field

Example:

"956623520-4"

included.PackagingInfill.infill_options.weight

Weight · object

The weight of the infill. Optional Field

Show child attributes

included.PackagingInfill.infill_options.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingInfill.infill_options.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingInfill.infill_options.manage_stock

enum<boolean>

Available options:

true,

false

included.PackagingInfill.infill_options.associated_products

ProductRef · object[]

A list of products with this packaging feature selected in its "Other Special Features" option in the product's "Packaging" tab.

Show child attributes

included.PackagingInfill.infill_options.associated_products.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.PackagingInfill.infill_options.associated_products.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.PackagingInfill.infill_options.allow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will only be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingInfill.infill_options.allow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingInfill.infill_options.allow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInfill.infill_options.disallow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will not be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingInfill.infill_options.disallow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingInfill.infill_options.disallow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInfill.infill_options.billing_amount

Monetary · object

The amount that will be billable for consumption of one unit of this packaging feature.
Optional Field

Show child attributes

included.PackagingInfill.infill_options.billing_amount.amount

number<float>

This is the monetary value..

Example:

99

included.PackagingInfill.infill_options.billing_amount.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.PackagingInfill.infill_options.disable_confirm_button

enum<boolean>

If "No", the user will be able to tap "Confirm" rather than scanning a barcode.

Available options:

true,

false

included.PackagingInfill.infill_options.apply_unless_container_meets_hazmat

enum<boolean>

If "Yes", this packaging product will be applicable unless a package contains a DG item with "Container Meets Hazmat Specs: Yes" when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingInfill.infill_options.is_confirmation_required

enum<boolean>

If "Yes", this packer will be prompted and required to confirm the use of infill.

Available options:

true,

false

included.PackagingInfill.infill_options.infill_horizontal

Length · object

The amount of space to reserve on each horizontal side of the package for infill.
Optional Field

Show child attributes

included.PackagingInfill.infill_options.infill_horizontal.value

number<float>

This value describes the length of the object as a floating-point number up to 4 decimal places.

Example:

12

included.PackagingInfill.infill_options.infill_horizontal.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

included.PackagingInfill.infill_options.infill_vertical

Length · object

The amount of space to reserve on each vertical side of the package for infill. Optional Field

Show child attributes

included.PackagingInfill.infill_options.infill_vertical.value

number<float>

This value describes the length of the object as a floating-point number up to 4 decimal places.

Example:

12

included.PackagingInfill.infill_options.infill_vertical.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

included.PackagingInfill.infill_options.infill_priority

integer

If multiple infill types are prescribed for a mix of items, the infill with the lowest Infill Priority number will prevail.

included.PackagingInfill.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.PackagingInfill.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.PackagingInfill.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.PackagingInfill.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.PackagingInfill.merchant.type

enum<string>

required

Available options:

Merchant

included.PackagingInfill.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInfill.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.PackagingInfill.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.PackagingInstruction

PackagingInstruction · object[]

Show child attributes

included.PackagingInstruction.type

enum<string>

This property describes the type of object in the response body.

Available options:

PackagingInstruction

included.PackagingInstruction.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.PackagingInstruction.instruction_options

object

Show child attributes

included.PackagingInstruction.instruction_options.barcodes

A comma separated list of unique packaging feature barcodes.
Optional Field

Example:

"956623520-4"

included.PackagingInstruction.instruction_options.associated_products

ProductRef · object[]

A list of products with this packaging feature selected in its "Other Special Features" option in the product's "Packaging" tab.

Show child attributes

included.PackagingInstruction.instruction_options.associated_products.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.PackagingInstruction.instruction_options.associated_products.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.PackagingInstruction.instruction_options.allow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will only be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingInstruction.instruction_options.allow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingInstruction.instruction_options.allow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInstruction.instruction_options.disallow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will not be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingInstruction.instruction_options.disallow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingInstruction.instruction_options.disallow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInstruction.instruction_options.billing_amount

Monetary · object

The amount that will be billable for consumption of one unit of this packaging feature.
Optional Field

Show child attributes

included.PackagingInstruction.instruction_options.billing_amount.amount

number<float>

This is the monetary value..

Example:

99

included.PackagingInstruction.instruction_options.billing_amount.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.PackagingInstruction.instruction_options.allow_for_shipping_methods

string[]

If specified, this packaging feature will only be applicable to the selected carriers/shipping methods.

included.PackagingInstruction.instruction_options.apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments containing an item with this Goods Type.

NORMAL Not Regulated
ORM_D ORM-D Optional Field

Available options:

any,

NORMAL,

ORM_D

included.PackagingInstruction.instruction_options.never_apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments which do not contain an item with this Goods Type.

NORMAL Not Regulated
LIMITED_QUANTITIES_COMMODITIES Limited Quantities: Consumer Commodity
HAZMAT Regulated Optional Field

Available options:

NORMAL,

LIMITED_QUANTITIES_COMMODITIES,

HAZMAT

included.PackagingInstruction.instruction_options.apply_only_above_weight

Weight · object

If specified, this packaging product is not a requirement for packages under the given weight when "Always/Never Apply to Goods Type" is specified.
Optional Field

Show child attributes

included.PackagingInstruction.instruction_options.apply_only_above_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingInstruction.instruction_options.apply_only_above_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingInstruction.instruction_options.one_per

enum<string>

The expected number of scans per shipment. The product "Unit Quantity" is used as a multiplier for "One Scan Per: Each".

Available options:

order,

package,

item,

each

included.PackagingInstruction.instruction_options.require_scan_timing

enum<string>

Choose how the scan timer should begin recording time data on this product or packaging feature.

Available options:

after_product_scan|on_full,

on_start

included.PackagingInstruction.instruction_options.disable_confirm_button

enum<boolean>

If "No", the user will be able to tap "Confirm" rather than scanning a barcode.

Available options:

true,

false

included.PackagingInstruction.instruction_options.require_packaging_type

enum<string>

Available options:

overbox,

non_overbox

included.PackagingInstruction.instruction_options.apply_to_region

string

Unless specified, this packaging feature will apply to all regions when "Always/Never Apply to Goods Type" is specified.

included.PackagingInstruction.instruction_options.apply_unless_container_meets_hazmat

enum<boolean>

If "Yes", this packaging product will be applicable unless a package contains a DG item with "Container Meets Hazmat Specs: Yes" when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingInstruction.instruction_options.apply_to_multi_sku_package

enum<boolean>

If "Yes", this packaging product will only be applied to packages containing more than one SKU when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingInstruction.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.PackagingInstruction.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.PackagingInstruction.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.PackagingInstruction.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.PackagingInstruction.merchant.type

enum<string>

required

Available options:

Merchant

included.PackagingInstruction.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInstruction.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.PackagingInstruction.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.PackagingSupplies

PackagingSupplies · object[]

Show child attributes

included.PackagingSupplies.type

enum<string>

This property describes the type of object in the response body.

Available options:

PackagingSupplies

included.PackagingSupplies.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.PackagingSupplies.supplies_options

object

Show child attributes

included.PackagingSupplies.supplies_options.barcodes

A comma separated list of unique packaging feature barcodes.
Optional Field

Example:

"956623520-4"

included.PackagingSupplies.supplies_options.weight

Weight · object

The weight of the infill. Optional Field

Show child attributes

included.PackagingSupplies.supplies_options.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingSupplies.supplies_options.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingSupplies.supplies_options.manage_stock

enum<boolean>

Available options:

true,

false

included.PackagingSupplies.supplies_options.associated_products

ProductRef · object[]

A list of products with this packaging feature selected in its "Other Special Features" option in the product's "Packaging" tab.

Show child attributes

included.PackagingSupplies.supplies_options.associated_products.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.PackagingSupplies.supplies_options.associated_products.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.PackagingSupplies.supplies_options.allow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will only be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingSupplies.supplies_options.allow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingSupplies.supplies_options.allow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingSupplies.supplies_options.disallow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will not be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingSupplies.supplies_options.disallow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingSupplies.supplies_options.disallow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingSupplies.supplies_options.billing_amount

Monetary · object

The amount that will be billable for consumption of one unit of this packaging feature.
Optional Field

Show child attributes

included.PackagingSupplies.supplies_options.billing_amount.amount

number<float>

This is the monetary value..

Example:

99

included.PackagingSupplies.supplies_options.billing_amount.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.PackagingSupplies.supplies_options.allow_for_warehouses

(WarehouseRef · object | null)[]

If specified, this packaging feature will only be applicable to the selected warehouses.

A reference to a Warehouse by id.

Show child attributes

included.PackagingSupplies.supplies_options.allow_for_warehouses.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Warehouse

included.PackagingSupplies.supplies_options.allow_for_warehouses.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

included.PackagingSupplies.supplies_options.allow_for_shipping_methods

string[]

If specified, this packaging feature will only be applicable to the selected carriers/shipping methods.

included.PackagingSupplies.supplies_options.packaging_handling_surcharge

enum<boolean>

The Packaging Surcharge is applicable for this packaging feature (e.g. cylindrical, non-fiberboard material, protrusions, non-conveyable, etc.)

Available options:

true,

false

included.PackagingSupplies.supplies_options.apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments which do not contain an item with this Goods Type.

NORMAL Not Regulated
ORM_D ORM-D Optional Field

Available options:

any,

NORMAL,

ORM_D

included.PackagingSupplies.supplies_options.never_apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments which do not contain an item with this Goods Type.

NORMAL Not Regulated
LIMITED_QUANTITIES_COMMODITIES Limited Quantities: Consumer Commodity
HAZMAT Regulated Optional Field

Available options:

NORMAL,

LIMITED_QUANTITIES_COMMODITIES,

HAZMAT

included.PackagingSupplies.supplies_options.apply_only_above_weight

Weight · object

If specified, this packaging supply is not a requirement for packages under the given weight when "Always/Never Apply to Goods Type" is specified. Optional Field

Show child attributes

included.PackagingSupplies.supplies_options.apply_only_above_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingSupplies.supplies_options.apply_only_above_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingSupplies.supplies_options.one_per

enum<string>

The expected number of scans per shipment. The product "Unit Quantity" is used as a multiplier for "One Scan Per: Each".

Available options:

order,

package,

item,

each

included.PackagingSupplies.supplies_options.require_scan_timing

enum<string>

Choose how the scan timer should begin recording time data on this product or packaging feature.

Available options:

after_product_scan|on_full,

on_start

included.PackagingSupplies.supplies_options.disable_confirm_button

enum<boolean>

If "No", the user will be able to tap "Confirm" rather than scanning a barcode.

Available options:

true,

false

included.PackagingSupplies.supplies_options.require_packaging_type

enum<string>

Available options:

overbox,

non_overbox

included.PackagingSupplies.supplies_options.apply_to_region

string

Unless specified, this packaging feature will apply to all regions when "Always/Never Apply to Goods Type" is specified.

included.PackagingSupplies.supplies_options.apply_unless_container_meets_hazmat

enum<boolean>

If "Yes", this packaging product will be applicable unless a package contains a DG item with "Container Meets Hazmat Specs: Yes" when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingSupplies.supplies_options.apply_to_multi_sku_package

enum<boolean>

If "Yes", this packaging product will only be applied to packages containing more than one SKU when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingSupplies.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.PackagingSupplies.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.PackagingSupplies.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.PackagingSupplies.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.PackagingSupplies.merchant.type

enum<string>

required

Available options:

Merchant

included.PackagingSupplies.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingSupplies.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.PackagingSupplies.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.Product

(Product · object | PackagingContainer · object | PackagingSupplies · object | PackagingInfill · object)[]

A Product contains information about a sellable item.

Product
PackagingContainer
PackagingSupplies
PackagingInfill

Show child attributes

included.Product.type

enum<string>

This property describes the type of object in the response body.

Available options:

Product

included.Product.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.Product.vendor_sku

string | null

For informational use only. Displayed during delivery processing to help match products.
Optional Field

Example:

"Vendor-SKU-1AD2"

included.Product.external_id

string | null

May be used for external product sync.

Example:

"11-993-9048"

included.Product.barcodes

A comma separated list of unique packaging feature barcodes.

Example:

["956623520-4", "O-VS-Oregano-p3"]

included.Product.goods_type

enum<string>

This defines the regulations, if any, assigned to a Product.

NORMAL Not Regulated
ORM_D ORM-D
LIMITED_QUANTITIES_COMMODITIES Limited Quantities: Consumer Commodity
HAZMAT Regulated

Available options:

NORMAL,

ORM_D,

LIMITED_QUANTITIES_COMMODITIES,

HAZMAT

included.Product.is_available

enum<boolean>

default:true

This flag must be true to allow the Product to be ordered.

Available options:

true,

false

included.Product.is_visible

enum<boolean>

default:true

This flag must be true to show the Product in the inventory feed.

Available options:

true,

false

included.Product.lot_type

LotTypeRef · object

This LotType determines how a Product should be "burned" and whether lots with dissimilar data can be "mixed".
Optional Field

Show child attributes

included.Product.lot_type.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

LotType

included.Product.lot_type.id

integer<int64>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Product.weight

Weight · object

This object defines the weight of the Product in imperial or metric units.
Optional Field

Show child attributes

included.Product.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Product.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Product.dimensions

Dimensions · object

This object defines the length, width, and height of the Product in imperial or metric units.
Optional Field

Show child attributes

included.Product.dimensions.length

number<float>

This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places.

Example:

8

included.Product.dimensions.width

number<float>

This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

6

included.Product.dimensions.height

number<float>

This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

4

included.Product.dimensions.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

included.Product.volume

Volume · object

This object defines the cubic size of the Product in imperial or metric units.
Optional Field

Show child attributes

included.Product.volume.value

number<float>

This value describes the cubic size of the subject as a floating-point number up to 4 decimal places.

Example:

300

included.Product.volume.unit

enum<string>

The imperical or metric unit of measurement as a cubic value.

Available options:

in^3,

mm^3,

cm^3,

m^3

included.Product.inventory

Inventory · object

This object describes how the Product Stock is defined, such as real config values, or Virtual Inventory, and how to handle Backorders.
Optional Field

Show child attributes

included.Product.inventory.backorders

This determines if Product that is no longer in stock may be backordered or whether or not to use ShipStream's scoped configurations.

Example:

true

included.Product.inventory.dynamic_allocation

This will allow the Product to source from inventory in other warehouses in real-time if enabled, and can be set to use ShipStream's scoped configurations.

Example:

true

included.Product.inventory.virtual_inventory

enum<string>

This is the method used to predict an esitmate of inventory available when kitting from the Product.

Available options:

none,

optimistic,

realistic,

pessimistic

Example:

"optimistic"

included.Product.export

Export · object

This object contains fields for describing and codifying an internationally exportable Product.
Optional Field

Show child attributes

included.Product.export.description

string | null

This is used to describe in detail the Product for international shipping and customs regulations.

Example:

"Plastic children's toy with steel weights and ball bearings"

included.Product.export.customs_value

Monetary · object

The value of the products the purpose of calculating duties and taxes in the destination country.

Show child attributes

included.Product.export.customs_value.amount

number<float>

This is the monetary value..

Example:

99

included.Product.export.customs_value.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.Product.export.country_of_manufacture

string | null

2 letters Country ISO Code

Example:

"TW"

included.Product.export.hs_base_code

string | null

This is the Harmonized System Code (HS Code); a standardized numerical method of classifying traded products. These are 6 digit codes in the format ###.## which are associated with a standard HS Code Description.

Example:

"8518.30"

included.Product.export.hs_country_extension

object[] | null

Show child attributes

included.Product.export.hs_country_extension.country_id

string

This is the two-digit ISO (Alpha-2) country code.

included.Product.export.hs_country_extension.extension

string

This is the Schedule C Country Code; a 4 digit code that identifies a country.

Example:

[
  { "country_id": "TW", "extension": "002" },
  { "country_id": "US", "extension": "011" }
]

included.Product.regulated_goods

RegulatedGoods · object

This object only applies a Product using the "Regulated" Goods Type, and describes the Regulation and container specifications for the Product.
Optional Field

Show child attributes

included.Product.regulated_goods.regulation

Regulation · object

A reference to a Regulation by id.

Show child attributes

included.Product.regulated_goods.regulation.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Regulation

included.Product.regulated_goods.regulation.id

integer

required

The internal id property used as a path parameter in a resource lookup.

included.Product.regulated_goods.technical_name

string | null

Must match against Regulation's Technical Name Pattern if specified.

Example:

"Hydro Polymer Acetylene Coating"

included.Product.regulated_goods.additional_information

string | null

Must match against Regulation's Additional Regulatory Information Pattern if specified.

Example:

"Flamable Liquid"

included.Product.regulated_goods.net_weight

Weight · object

Show child attributes

included.Product.regulated_goods.net_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Product.regulated_goods.net_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Product.regulated_goods.container_type

string | null

The Overpack Container Type can be a combination of material and container type such as Aluminum Box, Steel Drum, or a combination of a material and container type from these two lists:

Material: Aluminum, Fiberboard, Glass, Plywood, Plastic, Steel, Wood
Container: Bag, Bottle, Box, Bucket, Cylinder, Drum, Jerrican, Pail

Example:

"Plastic Box"

included.Product.regulated_goods.container_meets_hazmat_specs

boolean

This flag indicates that the RegulatedGoods container is sufficient for a regulated (HAZMAT) product.

Example:

true

included.Product.regulated_goods.regulation_units

number<float>

These units are arbitrary and should be relative to the Regulation's Pickup Weight Limit. E.g. it could be in pounds, kilowatt/hours, etc.

Example:

5

included.Product.packaging

Packaging · object

This object defines how the shipping container/box for the Product is to be processed and whether there are any special instructions during packing.
Optional Field

Show child attributes

included.Product.packaging.require_packaging

enum<boolean>

If Yes, packaging will require a Box with "Satisfies Overbox: Yes".

Available options:

true,

false

Example:

true

included.Product.packaging.require_weight_check

enum<boolean>

If Yes, the associated product will require the use of a scale to verify that the package's weight falls within the expected amount. If this is set to No, this step will be skipped by the packer.

Available options:

true,

false

Example:

true

included.Product.packaging.require_confirmation_per_item

enum<boolean>

If Yes, Packaging Products with "One Scan Per: Item" will require a scan for each item packed rather than just one for the first item in a package.

Available options:

true,

false

Example:

true

included.Product.packaging.unit_quantity

integer | null

Number of individually packaged items contained therein for purposes of special packaging features.

Example:

1

included.Product.packaging.bulk_quantity

integer | null

Prefer to split into packages when necessary using multiples of this amount.

Example:

10

included.Product.packaging.max_per_package

integer | null

The maximum quantity of this product to ever include in the same package. Multiply by "Unit Quantity" to achieve common units between other products with the same "Ship Separate Tag" value.

Example:

15

included.Product.packaging.is_ship_separately

enum<boolean>

This item cannot ship in the same package as other items (unless they have the same "Ship Separate Tag").

Available options:

true,

false

Example:

true

included.Product.packaging.ship_separately_tag

string | null

Applies only if "Ship Separate" is "Yes". Assign the same tag to treat similar products as interchangeable with respect to the "Ship Separate" and "Max Per Package" attribute.

Example:

"PVC"

included.Product.packaging.can_tip

enum<boolean>

If Yes, the item is allowed to be rotated vertically when packed.

Available options:

true,

false

Example:

true

included.Product.packaging.can_contain_other_items

enum<boolean>

If Yes then other smaller items are allowed to be placed within this larger item. This is useful when the item is hollow or is a bin/bucket.

Available options:

true,

false

Example:

true

included.Product.packaging.is_handling_surcharge

enum<boolean>

The Packaging Surcharge is applicable when shipped without an Overbox.

Available options:

true,

false

Example:

true

included.Product.custom_fields

(object | null)[]

This will set any Product Attributes, pre-defined by the user, for the Product.
Optional Field

Example:

[
  {
    "code": "color",
    "value": 13,
    "label": "Red and Black"
  },
  { "code": "cost_of_goods", "value": 41.32 },
  { "code": "allow_mailer", "value": true }
]

included.Product.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.Product.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.Product.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.Product.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.Product.merchant.type

enum<string>

required

Available options:

Merchant

included.Product.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Product.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.Product.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.Rack

(Rack · object | null)[]

A Rack is a grouping of locations in a warehouse implying a very close proximity.

Show child attributes

included.Rack.type

enum<string>

This property describes the type of object in the response body.

Available options:

Rack

included.Rack.id

integer

The internal id property used as a path parameter in a resource lookup.

Example:

54

included.Warehouse

Warehouse · object[]

Show child attributes

included.Warehouse.type

enum<string>

required

This is a read-only property that describes the type of object in the response body.

Available options:

Warehouse

included.Warehouse.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.Warehouse.name

string

The display name for the Warehouse.

Maximum string length: 255

Example:

"East Coast 1"

included.Warehouse.is_active

boolean

This flag determines if the Warehouse is active and viable for fulfillment.

Example:

true

has_more

boolean

True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.

string | null

The resource path for the next page of results if any are expected.

string | null

The resource path for the previous page of results if any are expected.

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

Authorizations

Path Parameters

Query Parameters

Response